﻿/*
* Copyright (c) 2010-2012 Tesla Engine Group
* 
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
* 
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
* 
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/

using System.Collections.Generic;

namespace Tesla.Graphics {
    /// <summary>
    /// Defines the interface for a bucket that stores a list of IRenderables that are to be sorted and rendered.
    /// </summary>
    public interface IRenderBucket : IEnumerable<IRenderable> {

        /// <summary>
        /// Gets the current number of renderables contained in the bucket.
        /// </summary>
        int Count {
            get;
        }

        /// <summary>
        /// Gets the renderable at the given index in the bucket.
        /// </summary>
        /// <param name="index">Zero-based index</param>
        /// <returns>The renderable at the index, if it exists</returns>
        IRenderable this[int index] {
            get;
        }

        /// <summary>
        /// Gets the current renderer assigned to this render bucket.
        /// </summary>
        IRenderer Renderer {
            get;
        }

        /// <summary>
        /// Gets the bucket comparer owned by this bucket.
        /// </summary>
        IRenderBucketComparer BucketComparer {
            get;
        }

        /// <summary>
        /// Adds a renderable to the bucket.
        /// </summary>
        /// <param name="renderable">Renderable to add</param>
        void Add(IRenderable renderable);

        /// <summary>
        /// Removes a renderable from the bucket.
        /// </summary>
        /// <param name="renderable">Renderable to remove</param>
        void Remove(IRenderable renderable);

        /// <summary>
        /// Clears all renderables from the bucket.
        /// </summary>
        void Clear();

        /// <summary>
        /// Renders all renderables in the bucket.
        /// </summary>
        void Render();

        /// <summary>
        /// Sorts all renderables in the bucket.
        /// </summary>
        void Sort();
    }
}
